home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / alarm400.zip / ATC.DOC < prev    next >
Text File  |  1987-10-11  |  8KB  |  190 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                          ATC : The Alarm Tune Compiler
  7.                            Version 1.00, 11-Oct-1987
  8.                                   SMG Software
  9.  
  10.                              (C) Copyright 1987 by
  11.                                Steven Georgiades
  12.                               All Rights Reserved
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.          ATC  is the Alarm Tune Compiler,  a  program which will allow  the 
  21.     user to convert a music source file (MSF) to a binary format compatible 
  22.     with  the ALARM Memory Resident Alarm Clock Program,  and the ATP Alarm 
  23.     Tune Play utility.   The MSF format is described on the following page.  
  24.     The ATC program is invoked as follows: 
  25.  
  26.          ATC msffile [tunefile]
  27.  
  28.     where  msffile is the filename of the input MSF file,  and tunefile  is 
  29.     the  name of the output binary tune file.   If the extension is omitted 
  30.     from  msffile,  a  default of ".MSF"  is assumed.   For tunefile,   the 
  31.     default  extension  is ".TUN".   If tunefile is omitted entirely,   the 
  32.     output file will have the same base name as msffile, with the extension 
  33.     ".TUN".    Both  the msffile and tunefile may optionally have  a  drive 
  34.     letter  and/or path specification.   The resulting binary tune file  be 
  35.     played using the ATP utility, as follows: 
  36.  
  37.          ATP tunefile
  38.  
  39.     As with ATC,  if the extension is omitted from tunefile, ATP assumes an 
  40.     extension of ".TUN".  
  41.  
  42.     ATC, Version 1.00                                                Page 2
  43.  
  44.  
  45.  
  46.  
  47.     MUSIC SOURCE FILE FORMAT
  48.  
  49.          The  Music Source File (MSF)  is a simple ASCII file which may  be 
  50.     created  with  any text editor,  or word processor with an  ASCII  save 
  51.     option.  The MSF format consists of only a few commands.  
  52.          Comments  may appear after any command on the same line,  or on  a 
  53.     line by themselves.  A comment is defined by a leading semi-colon.  All 
  54.     text following a semi-colon is assumed to be part of a comment,  and is 
  55.     therefore ignored.  Note also that ATC ignores blank lines,  so you may 
  56.     insert blank lines for readability (to seperate measures, for example). 
  57.          The first command in an MSF file must be a Name Command,  and  the 
  58.     second must be a Tempo Command.   These commands are not optional,  and 
  59.     must appear only once in any MSF file.   Comment lines and blank  lines 
  60.     are permitted to preceed the Name Command and the Tempo Command.  
  61.  
  62.  
  63.  
  64.  
  65.     Name Command
  66.     ------------
  67.  
  68.          Ntunename
  69.  
  70.          The  name  command  specifies the tune name to insert in  the 
  71.          tune file,  for use  by the ALARM program.   The  text of the 
  72.          name  immediately  follows  the command letter "N",  with  no 
  73.          quotes  or other delimiters necessary.   The tunename may  be 
  74.          any  length,   but if it is greater than  32   characters  in 
  75.          length, it is truncated to 32 characters.  
  76.  
  77.      Tempo Command
  78.      -------------
  79.  
  80.          Tval
  81.  
  82.          The  tempo command specifies the basic tempo or speed of  the 
  83.          tune.   The "val"  may be any number from 11 to 1200,  and is 
  84.          approximately  equal  to  the number of  Basic  Timing  Units 
  85.          (BTU's) per 10-second interval.  
  86.  
  87.     ATC, Version 1.00                                                Page 3
  88.  
  89.  
  90.  
  91.  
  92.     MUSIC SOURCE FILE FORMAT (Continued)
  93.  
  94.     Play Command
  95.     ------------
  96.  
  97.          Pdur[,[note1][,[note2][,[note3]]]]
  98.  
  99.          Where "dur" is the duration of the note in terms of the Basic 
  100.          Timing Unit (BTU,  defined by the tempo).  I tend to consider 
  101.          the sixteenth note as the BTU, so that "dur"  for a 16th note 
  102.          would be 1, for a quarter note it would be 4, and for a whole 
  103.          note, 16.  You may want to use the 32nd note as your BTU,  or 
  104.          a  quarter note.   It is entirely arbitrary.   Just  remember 
  105.          that  the tempo really relies on your chosen BTU as  well  as 
  106.          the tempo value selected.   The entries "note1", "note2"  and 
  107.          "note3" are the three  optional  notes that make up the chord 
  108.          to be  played.  Each note consists of 2 or 3 characters.  The 
  109.          first character  is a numeral  from  0 to 7  indicating which 
  110.          octave the note is in.  The second character is a letter from 
  111.          A  to G,  defining what  note  in that octave is to be  used.  
  112.          Note that ATC considers  the lowest note in each octave to be 
  113.          an  A,   and the highest is a  G.    The  third character  is 
  114.          optional,   and can be either a + or a -.   A  plus means  to 
  115.          increase  the  note by one half step (sharp),  while a  minus 
  116.          means  to  decrease the note by one half step (flat).   If  a 
  117.          note  is  omitted  or  substituted with an "R",  a   rest  is 
  118.          assumed, and if a note is substituted with an asterisk ("*"), 
  119.          the  note for that voice is assumed to be the same as in  the 
  120.          previous chord.  
  121.  
  122.  
  123.      End Command
  124.      -----------
  125.  
  126.          E
  127.  
  128.          When this command  is  encountered,  ATC stops processing the 
  129.          input file and terminates.  
  130.  
  131.  
  132.     If this format is unclear,  look at some of the ".MUS"  files supplied.  
  133.     They can be informative.  
  134.  
  135.     ATC, Version 1.00                                                Page 4
  136.  
  137.  
  138.  
  139.  
  140.          The  ATC  and ATP programs are subsidiary utilities of  the  ALARM 
  141.     program,  and are distributed as ShareWare.  "ShareWare" means that you 
  142.     are  granted  free license to use,  copy and distribute this  software, 
  143.     within the following restrictions: 
  144.  
  145.          1).  It must be distributed in its original,  unmodified  form, 
  146.               including program, documentation and all associated files.  
  147.  
  148.          2).  No  fee may be charged for use,  copying  or  distribution 
  149.               (With the exception of nominal "per disk" copying charges, 
  150.               not to exceed $6.00 per disk).  
  151.  
  152.          3).  The  program  may  not  be included with  other  goods  or 
  153.               services supplied for a fee,  unless written permission to 
  154.               do so is obtained in advance from the author.  
  155.  
  156.     Although distributed as part of the ALARM program, feel free to use and 
  157.     distribute  ATC  and ATP independently of ALARM.   For  information  on 
  158.     registering  or  obtaining source code for ATC and ATP,  refer  to  the 
  159.     ALARM program documentation.  
  160.  
  161.          This program is provided AS IS without any warranty,  expressed or 
  162.     implied,  including but  not limited to fitfulness for a particular use 
  163.     or  purpose.   Neither the author nor SMG Software assume liability for 
  164.     any damages incurred through the use of the program.  
  165.  
  166.          If you have any problem,  or feel you have found a bug in these or 
  167.     any other SMG programs, please let me know.  I also welcome any and all 
  168.     questions   and  comments.    Address  all  correspondence   (including 
  169.     registrations) to the following address: 
  170.  
  171.                 Steven Georgiades
  172.                 SMG Software
  173.                 701-H South Hayward Street
  174.                 Anaheim, CA  92804
  175.  
  176.     Or leave a message for me on the Circuit Board:
  177.  
  178.                 The Circuit Board RBBS
  179.                 SysOp: Dave Kleinschmidt
  180.                 (714) 778-0948
  181.                 1200/2400 Baud, No Fee
  182.  
  183.     All  SMG  Software  is  initially released to the  public  through  the 
  184.     Circuit  Board.   The latest version of any SMG Software can always  be 
  185.     found there.  
  186.  
  187.     A diskette containing all of the latest SMG Software can be obtained by 
  188.     sending a check or money order for $6.00  to the above address.    Make 
  189.     all checks payable to Steven M. Georgiades.  Thank you.  
  190.